Skip to content

Bump API schema to 8da67f72 - #20006

Merged
sentry-api-schema-updater[bot] merged 1 commit into
masterfrom
bot/bump-api-schema-to-8da67f72
Oct 15, 2026
Merged

Bump API schema to 8da67f72#20006
sentry-api-schema-updater[bot] merged 1 commit into
masterfrom
bot/bump-api-schema-to-8da67f72

Conversation

@sentry-api-schema-updater

@sentry-api-schema-updater sentry-api-schema-updater Bot commented Oct 15, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@vercel

vercel Bot commented Oct 15, 2026 •
edited
Loading

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
develop-docs Ready Ready Preview Oct 15, 2026 4:03pm UTC
sentry-docs Ready Ready Preview Oct 15, 2026 4:03pm UTC

Request Review

@sentry-api-schema-updater
sentry-api-schema-updater Bot merged commit 84cdbd0 into master Oct 15, 2026
0 of 2 checks passed
@sentry-api-schema-updater
sentry-api-schema-updater Bot deleted the bot/bump-api-schema-to-8da67f72 branch October 15, 2026 15:56
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 15, 2026
@github-actions

github-actions Bot commented Oct 15, 2026

Copy link
Copy Markdown
Contributor

Please update the IS YOUR CHANGE URGENT? section of the PR description:

  • Select exactly one option.
  • If you selected an urgent or other deadline, provide the date as YYYY-MM-DD.

This information helps the Docs team prioritize your review.

@cursor

cursor Bot commented Oct 15, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

The plan watches page loads of two new API reference pages. It also watches API reference volume and pageload failures. An issue escalates when pageload failures rise or those page loads fall.

Services: sentry-docs, develop-docs.

Mention @change-monitor in a comment to update the plan.

Plan

What changed

The API reference now includes two experimental Integration Platform endpoints.
One page documents List Messaging Channels for an Integration.
The other page documents Validate a Messaging Channel for an Integration.
Those pages are served at /api/integration/list-messaging-channels-for-an-integration/.
They are also served at /api/integration/validate-a-messaging-channel-for-an-integration/.
sentry-docs must deploy before those pages are live.
develop-docs also ships this source file.
develop-docs does not generate OpenAPI pages.

Risk

A bad schema can fail the static build.
A render fault can break existing Integration Platform pages.
The new experimental pages can return errors.
Sibling API reference pages can return not-found responses if slugs change.

Intended effect

The new pages record docs.page.load with their endpoint slugs.
Those counters are zero before deploy because the pages do not exist.
Confirmed means those counters rise above zero after deploy.
Absent means they stay at zero while other Integration Platform pages still load.
These experimental pages may receive no visits.
If sibling Integration Platform loads hold and the new counters stay at zero, record unknown.

Signal Baseline Window Rule Source
docs.page.load for api_endpoint:validate-a-messaging-channel-for-an-integration 0 loads 2026-10-14T15:56:59Z to 2026-10-15T15:56:59Z Rise above 0 when the page is requested. Do not treat hold at 0 as a fault by itself. Sentry org sentry, project docs, environment production. Query sum(value, docs.page.load) with environment:production api_endpoint:validate-a-messaging-channel-for-an-integration.
docs.page.load for api_endpoint:list-messaging-channels-for-an-integration 0 loads 2026-10-14T15:56:59Z to 2026-10-15T15:56:59Z Rise above 0 when the page is requested. Do not treat hold at 0 as a fault by itself. Sentry org sentry, project docs, environment production. Query sum(value, docs.page.load) with environment:production api_endpoint:list-messaging-channels-for-an-integration.
docs.page.load for Integration Platform pages 14 loads in 24h, which is 1.7% of API page loads 2026-10-14T15:56:59Z to 2026-10-15T15:56:59Z Hold in 10-20 loads per 24h while API volume holds. This sibling volume decides unknown versus absent for the new counters. Sentry org sentry, project docs, environment production. Query sum(value, docs.page.load) with environment:production page_type:api api_category:integration.

Regression watch

A schema fault would show first as failed API pageloads or lost Integration Platform page loads.
Watch the whole API reference family, not only the two new pages.

Signal Baseline Window Rule Source
API pageload failure rate 2.1% from 333 pageloads. Site-wide pageload failure rate was 4.0% from 10393 pageloads. 2026-10-14T15:56:59Z to 2026-10-15T15:56:59Z Hold in 1.5-3.0%. Escalate if the rate rises above the site-wide 3.5-4.2% band. Only one 24h sample exists for this rate. Sentry org sentry, project docs, environment production. Query spans span.op:pageload environment:production (url.full:*/api/* OR transaction:*/api/*) and read failure_rate().
API page load volume 802 loads in 24h, which is 4.1% of 19657 total page loads. Prior 24h was 869. Seven-day total was 5102, or about 729 per day. 2026-10-14T15:56:59Z to 2026-10-15T15:56:59Z. Prior 24h is 2026-10-13T15:56:59Z to 2026-10-14T15:56:59Z. Seven-day window is 2026-10-08T15:56:59Z to 2026-10-15T15:56:59Z. Hold in 720-880 loads per 24h. Escalate if volume falls below 720 while total page loads hold near 19657 per 24h. Sentry org sentry, project docs, environment production. Query sum(value, docs.page.load) with environment:production page_type:api. Compare to sum(value, docs.page.load) with environment:production.
Integration Platform page loads 14 loads in 24h 2026-10-14T15:56:59Z to 2026-10-15T15:56:59Z Hold in 10-20 loads per 24h. Escalate if this slice falls below 8 while API volume holds. Volume is low, so treat single-digit shifts with care. Sentry org sentry, project docs, environment production. Query sum(value, docs.page.load) with environment:production page_type:api api_category:integration.
API not-found page loads 5 not-found loads in 24h across api/dashboards, api/events, and api/crons. api/integration was 0. 2026-10-14T15:56:59Z to 2026-10-15T15:56:59Z Hold in 3-8 not-found loads per 24h. Escalate if the count rises while API page loads hold. Escalate if requested_path:api/integration leaves 0. Sentry org sentry, project docs, environment production. Query sum(value, docs.page.not_found) with environment:production requested_path:api* grouped by requested_path.

API path errors were 3 TypeError events in the same 24h window.
If the failure rate rises, inspect those API path errors in Sentry project docs.

Not observable

develop-docs ships the same source file but does not serve these OpenAPI pages.
Intended effect cannot be confirmed on a develop-docs deploy.
Build-time schema fetch is not in production telemetry.
Page body accuracy is not in telemetry until a browser loads the new pages.
The API pageload failure rate has no prior-day sample.

This branch was successfully deployed

2 active deployments
Preview – sentry-docs — c5c4d910 Deployed Oct 15, 2026 by vercel[bot]
View deployment
Preview – develop-docs — c5c4d910 Deployed Oct 15, 2026 by vercel[bot]
View deployment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

Priority: Needs Triage The PR description is missing valid priority information

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

0 participants